<p class="Head1"><help:key-word value="Events on Objects" tag="kw66462_1" xmlns:help="http://openoffice.org/2000/help"/>Events on Objects</p>
<p class="Paragraph">When you insert an object in a document, you can assign a macro to some predefined events. This macro will then be executed when the event happens. In <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname>, you can get this function by using the corresponding object dialog. That means if the object is a frame, you should use the <span class="T1">Frame</span> <text:s text:c="" xmlns:text="http://openoffice.org/2000/text"/>dialog, and if it is a graphic, please use the <span class="T1">Graphic</span> dialog, etc. Depending on the object selected, a list of all events defined for the current object will be found either on the <help:link Id="67665" xmlns:help="http://openoffice.org/2000/help"><span class="T1">Macro</span></help:link> tab page of the Object dialog, or in the <span class="T1">Assign Macro</span> dialog.</p>
<p class="Paragraph">The macro is generally formulated in a SUB. The default composition of this SUB is as follows:</p>
<p class="Paragraph">Sub EventRoutine()</p>
<p class="Paragraph">[command lines]</p>
<p class="Paragraph">End Sub</p>
<p class="Paragraph">The SUB EventRoutine should then be linked to an event. It will be initiated as soon as the event occurs.</p>
<p class="Head2"><help:key-word value="Linking special Events to frames" tag="kw66462_2" xmlns:help="http://openoffice.org/2000/help"/>Linking special Events to frames</p>
<p class="Paragraph">If you insert a frame in a text document, you will not only find the general events also used with other objects, e.g., to select an object etc., but also some special events, which can be used to change or move the frame. These events can be processed in different ways. You can link them to a Basic FUNCTION, where it can be decided whether the event is to be processed by <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> Writer or by the FUNCTION itself.</p>
<p class="Paragraph">Some parameters will be set for the FUNCTION. The first parameter is always the name of the frame. An integer value can be used to determine how the event should be processed. The following values are possible:</p>
<p class="Paragraph">0: The event will be processed by <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> Writer.</p>
<p class="Paragraph">1: The event will be processed by the FUNCTION.</p>
<p class="Paragraph">Use the return value "1", for example, to define that no character should be entered in the frame after a specified keyboard input, or to determine the action to be executed when using certain keys. The following examples illustrate this:</p>
<p class="Paragraph">If the FUNCTION KeyAlpha is linked to the event "Input of alphanumeric characters", all special characters entered by the user will be replaced by custom characters.</p>
<p class="PropText">Function KeyAlpha( sFrame as String, iCode as Integer ) as Integer</p>
<p class="PropText">Dim sChange as String</p>
<p class="PropText">iCode = &h00ff AND iCode REM only the lowermost byte correpsonds a key</p>
<p class="PropText"/>
<p class="PropText">REM a short transformation table</p>
<p class="PropText"><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/>KeyAlpha = 0 REM Character does not have to be replaced. <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> Writer displays it</p>
<p class="PropText">Else</p>
<p class="PropText"><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/>rem use the changed string</p>
<p class="PropText">KeyAlpha = 1 REM replace input</p>
<p class="PropText">End If</p>
<p class="PropText"/>
<p class="PropText">End Function</p>
<p class="PropText"/>
<p class="Paragraph">The next example demonstrates how formatting can be assigned directly via keyboard. If the FUNCTION KeyNoAlpha is linked to the event "Input of non-alphanumeric characters", predefined formatting will directly be assigned when predetermined shortcut keys are used.</p>
<p class="PropText">Function KeyNoAlpha( sFrame as String, iKey as Integer ) as Integer</p>
<p class="PropText"/>
<p class="PropText">KeyNoAlpha = 1</p>
<p class="PropText"/>
<p class="PropText">Select Case iKey</p>
<p class="PropText">Case 5382: REM (Shift)+(Del) deletes all frame contents</p>
<p class="PropText">Case 12800: REM (Ctrl)(Shift)+(A) Aligns the frame to the center.</p>
<p class="PropText"><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/>Rem center the frame</p>
<p class="PropText">Case 12802: REM (Ctrl)(Shift)+(C) makes the background pinkish</p>
<p class="PropText"><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/>REM Set Background color= RGB(255,127,127)</p>
<p class="PropText"/>
<p class="PropText"><text:tab-stop xmlns:text="http://openoffice.org/2000/text"/>Case else REM All other keys do not have special functions; thus try to execute them using $[officename ] Writer</p>
<p class="PropText"/>
<p class="PropText">KeyNoAlpha = 0</p>
<p class="PropText"/>
<p class="PropText">End Select</p>
<p class="PropText"/>
<p class="PropText">End Function</p>
<p class="PropText"/>
<p class="Paragraph">The passed parameters of the FUNCTION depend of the corresponding event:</p>
<p class="TextInTable">FUNCTION FramePosition(FrameName as String, X as Long, Y as Long) as Integer</p>
</span></td></tr></table>
<p class="Paragraph"/>
<p class="P3">Parameter</p>
<p class="Paragraph">FrameName: Name of the frame, in which the respective event occurs.</p>
<p class="Paragraph">Code: The ASCII code for the character to be entered.</p>
<p class="Paragraph">KeyCode: A <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> specific code for the nonprinting character to be entered.</p>
<p class="Paragraph">HandleID: The ID number of the point, at which the frame size will be changed. The following values are possible:</p>
